【Android TimeCat】 当RxJava遇到Retrofit（二）api注解@Path, @Url等

Android Retrofit
  1. 1. 背景
  2. 2. 初始化Retrofit
  3. 3. GET
    1. 3.1. 样式1（一个简单的get请求）
    2. 3.2. 样式2（URL中有参数）
    3. 3.3. 样式3（参数在URL问号之后）
    4. 3.4. 样式4（多个参数在URL问号之后，且个数不确定）
  4. 4. POST
    1. 4.1. 样式1（需要补全URL，post的数据只有一条reason）
    2. 4.2. 样式2（需要补全URL，问号后加入access_token，post的数据只有一条reason）
    3. 4.3. 样式3（需要补全URL，问号后加入access_token，post一个body（对象））
  5. 5. DELETE
    1. 5.1. 样式1（需要补全URL）
    2. 5.2. 样式2（需要补全URL，问号后加入access_token）
    3. 5.3. 样式3（带有body）
  6. 6. PUT（这个请求很少用到，例子就写一个）
  7. 7. 总结
  8. 8. 参考

背景

下面分为GET、POST、DELETE还有PUT的请求，说明@Path、@Query、@QueryMap、@Body、@Field的用法。

初始化Retrofit

1
2
3
4
String BASE_URL = "http://192.168.88.105:8000/api/";
Retrofit retrofit = new Retrofit.Builder() 
        .baseUrl(BASE_URL)
        .build();

GET

样式1（一个简单的get请求）

http://192.168.88.105:8000/api/News

1
2
@GET("News")
Call<NewsBean> getItem();

样式2（URL中有参数）

http://192.168.88.105:8000/api/News/1
http://192.168.88.105:8000/api/News/{资讯id}

1
2
3

@GET("News/{newsId}")
Call<NewsBean> getItem(@Path("newsId") String newsId);

或
http://192.168.88.105:8000/api/News/1/类型1
http://192.168.88.105:8000/api/News/{资讯id}/{类型}

1
2
@GET("News/{newsId}/{type}")
Call<NewsBean> getItem(@Path("newsId") String newsId， @Path("type") String type);

样式3（参数在URL问号之后）

http://192.168.88.105:8000/api/News?newsId=1
http://192.168.88.105:8000/api/News?newsId={资讯id}

1
2
@GET("News")
Call<NewsBean> getItem(@Query("newsId") String newsId);

或
http://192.168.88.105:8000/api/News?newsId=1&type=类型1
http://192.168.88.105:8000/api/News?newsId={资讯id}&type={类型}

1
2
@GET("News")
Call<NewsBean> getItem(@Query("newsId") String newsId， @Query("type") String type);

样式4（多个参数在URL问号之后，且个数不确定）

http://192.168.88.105:8000/api/News?newsId=1&type=类型1…
http://192.168.88.105:8000/api/News?newsId={资讯id}&type={类型}…

1
2
@GET("News")
Call<NewsBean> getItem(@QueryMap Map<String, String> map);

也可以

1
2
3
4
@GET("News")
Call<NewsBean> getItem(
          @Query("newsId") String newsId，
          @QueryMap Map<String, String> map);

POST

样式1（需要补全URL，post的数据只有一条reason）

http://192.168.88.105:8000/api/Comments/1
http://192.168.88.105:8000/api/Comments/{newsId}

1
2
3
4
5
@FormUrlEncoded
@POST("Comments/{newsId}")
Call<Comment> reportComment(
    @Path("newsId") String commentId,
    @Field("reason") String reason);

样式2（需要补全URL，问号后加入access_token，post的数据只有一条reason）

http://192.168.88.105:8000/api/Comments/1?access_token=1234123
http://192.168.88.105:8000/api/Comments/{newsId}?access_token={access_token}

1
2
3
4
5
6
@FormUrlEncoded
@POST("Comments/{newsId}")
Call<Comment> reportComment(
    @Path("newsId") String commentId,
    @Query("access_token") String access_token,
    @Field("reason") String reason);

样式3（需要补全URL，问号后加入access_token，post一个body（对象））

http://192.168.88.105:8000/api/Comments/1?access_token=1234123
http://192.168.88.105:8000/api/Comments/{newsId}?access_token={access_token}

1
2
3
4
5
@POST("Comments/{newsId}")
Call<Comment> reportComment(
    @Path("newsId") String commentId,
    @Query("access_token") String access_token,
    @Body CommentBean bean);

DELETE

样式1（需要补全URL）

http://192.168.88.105:8000/api/Comments/1
http://192.168.88.105:8000/api/Comments/{commentId}

1
2
3
@DELETE("Comments/{commentId}")
Call<ResponseBody> deleteNewsCommentFromAccount(
    @Path("commentId") String commentId);

样式2（需要补全URL，问号后加入access_token）

http://192.168.88.105:8000/api/Comments/1?access_token=1234123
http://192.168.88.105:8000/api/Comments/{commentId}?access_token={access_token}

1
2
3
4
@DELETE("Comments/{commentId}")
Call<ResponseBody> deleteNewsCommentFromAccount(
    @Path("commentId") String commentId，
    @Query("access_token") String access_token);

样式3（带有body）

http://192.168.88.105:8000/api/Comments

1
2
3
4
5
@HTTP(method = "DELETE",path = "Comments",hasBody = true)
Call<ResponseBody> deleteCommont(
            @Body CommentBody body
    );
CommentBody：需要提交的内容，与Post中的Body相同

PUT（这个请求很少用到，例子就写一个）

http://192.168.88.105:8000/api/Accounts/1
http://192.168.88.105:8000/api/Accounts/{accountId}

1
2
3
4
5
@PUT("Accounts/{accountId}")
Call<ExtrasBean> updateExtras(
    @Path("accountId") String accountId,
    @Query("access_token") String access_token,
    @Body ExtrasBean bean);

总结

Tips

  • Tips1 使用@Field时记得添加@FormUrlEncoded
  • Tips2 若需要重新定义接口地址，可以使用@Url，将地址以参数的形式传入即可。如
    1
    2
    3
    4
    5
    6
    @GET
    Call<List<Activity>> getActivityList(
            @Url String url,
            @QueryMap Map<String, String> map);
    Call<List<Activity>> call = service.getActivityList(
                "http://115.159.198.162:3001/api/ActivitySubjects", map);

参考

https://www.jianshu.com/p/7687365aa946
https://www.jianshu.com/p/6b3daeda1eed

当前网速较慢或者你使用的浏览器不支持博客特定功能，请尝试刷新或换用Chrome、Firefox等现代浏览器